Skip to main content

describeSnapshots

Description

describe about snapshot parameter

Request Method

GET

Request Path

/customer/disk/describe/snapshots

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
regionIdQueryStringYesNo sample value for this parameter. region id
instanceIdQueryStringNoNo sample value for this parameter. ecs instance id
diskIdQueryStringNoNo sample value for this parameter. ecs disk id

Return data

NameTypeSample valueDescription
resultobject`{"snapshots":[{"snapshotId":"s-1111","snapshotName":"test-shapshot","sourceDiskSize":40.0}]}`result
resultCodestring0result code
resultMsgstringsuccessresult message

Example

Successful Response example

{
"result":
{
"snapshots":
[
{
"snapshotId":"s-1111",
"snapshotName":"test-shapshot",
"sourceDiskSize":40.0
}

]

},
"resultCode":"0",
"resultMsg":"success"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}